Fix APM ES config documentation to correctly indicate applicability to both binary and Fleet-managed deployments #3343
+5
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… fleet-managed Co-authored-by: carsonip <[email protected]>
Copilot
AI
changed the title
[WIP] [Internal]: APM ES config incorrectly labeled as not applicable to fleet-managed APM
Fix APM ES config documentation to correctly indicate applicability to both binary and Fleet-managed deployments
Oct 6, 2025
Copilot finished work on behalf of
carsonip
October 6, 2025 14:30
🔍 Preview links for changed docs |
carsonip
approved these changes
Oct 6, 2025
carsonip
reviewed
Oct 6, 2025
Member
carsonip
left a comment
carsonip
left a comment
There was a problem hiding this comment.
This should also be backported to 8.x in observability-docs.
solutions/observability/apm/apm-server/configure-elasticsearch-output.md
Outdated
Show resolved
Hide resolved
…-output.md Co-authored-by: Colleen McGinnis <[email protected]>
solutions/observability/apm/apm-server/configure-elasticsearch-output.md
Outdated
Show resolved
Hide resolved
colleenmcginnis
approved these changes
Oct 15, 2025
rhr323
pushed a commit
to rhr323/docs-content
that referenced
this pull request
Oct 27, 2025
…o both binary and Fleet-managed deployments (elastic#3343) ## Problem The APM Elasticsearch output configuration documentation incorrectly indicated that it only applies to APM Server binary users and not Fleet-managed users. This was misleading because the ES configuration options described are actually applicable to both deployment methods. ## Solution Updated the documentation to correctly reflect that: - The configuration options apply to **both** APM Server binary and Fleet-managed users - The YAML configuration examples are specific to binary users - Fleet-managed users should configure these same APM-specific ES output settings through the Fleet UI - These APM-specific settings are distinct from the general Fleet ES output settings ## Changes Made 1. **Updated deployment indicator**: Changed from `observability-binary-yes-fm-no.svg` to `observability-binary-yes-fm-yes.svg` to show support for both deployment methods 2. **Revised note text**: Clarified that while the configs apply to both methods, the configuration approach differs: - Binary users: Configure via YAML (as shown in examples) - Fleet-managed users: Configure via Fleet UI (not the general Fleet ES output settings) ## Impact This fix ensures users understand that the valuable APM-specific Elasticsearch output configurations documented in this page are available to all APM users, regardless of their deployment method. Fleet-managed users will no longer be incorrectly directed away from APM-specific settings to general Fleet settings. Fixes: elastic/apm-server#18937 <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > > ---- > > *This section details on the original issue you should resolve* > > <issue_title>[Internal]: APM ES config incorrectly labeled as not applicable to fleet-managed APM</issue_title> > <issue_description>### Description > > Mirrors issue elastic/apm-server#18937 > > In https://www.elastic.co/docs/solutions/observability/apm/apm-server/configure-elasticsearch-output , > > > This documentation only applies to APM Server binary users. Fleet-managed users should see [Configure the Elasticsearch output](https://www.elastic.co/docs/reference/fleet/elasticsearch-output). > > but this is not accurate. The ES configs listed in [APM ES output docs](https://www.elastic.co/docs/solutions/observability/apm/apm-server/configure-elasticsearch-output) are applicable to both standalone and fleet-managed, but the way to configure them through yaml is specific to standalone. Fleet-managed APM needs to configure the [APM ES output configs ](https://www.elastic.co/docs/solutions/observability/apm/apm-server/configure-elasticsearch-output)(not [Fleet ES output configs](https://www.elastic.co/docs/reference/fleet/elasticsearch-output)) via fleet UI > > ### Resources > > https://www.elastic.co/docs/solutions/observability/apm/apm-server/configure-elasticsearch-output > > ### Which documentation set does this change impact? > > Elastic On-Prem and Cloud (all) > > ### Feature differences > > Applies to both on-prem and cloud > > ### What release is this request related to? > > 9.2 > > ### Serverless release > > NA > > ### Collaboration model > > The documentation team > > ### Point of contact. > > **Main contact:** @carsonip > > **Stakeholders:** > </issue_description> > > ## Comments on the Issue (you are @copilot in this section) > > <comments> > </comments> > </details> Fixes elastic#3342 <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/elastic/docs-content/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: carsonip <[email protected]> Co-authored-by: Carson Ip <[email protected]> Co-authored-by: Colleen McGinnis <[email protected]>
naemono
pushed a commit
to naemono/docs-content
that referenced
this pull request
Oct 28, 2025
…o both binary and Fleet-managed deployments (elastic#3343) ## Problem The APM Elasticsearch output configuration documentation incorrectly indicated that it only applies to APM Server binary users and not Fleet-managed users. This was misleading because the ES configuration options described are actually applicable to both deployment methods. ## Solution Updated the documentation to correctly reflect that: - The configuration options apply to **both** APM Server binary and Fleet-managed users - The YAML configuration examples are specific to binary users - Fleet-managed users should configure these same APM-specific ES output settings through the Fleet UI - These APM-specific settings are distinct from the general Fleet ES output settings ## Changes Made 1. **Updated deployment indicator**: Changed from `observability-binary-yes-fm-no.svg` to `observability-binary-yes-fm-yes.svg` to show support for both deployment methods 2. **Revised note text**: Clarified that while the configs apply to both methods, the configuration approach differs: - Binary users: Configure via YAML (as shown in examples) - Fleet-managed users: Configure via Fleet UI (not the general Fleet ES output settings) ## Impact This fix ensures users understand that the valuable APM-specific Elasticsearch output configurations documented in this page are available to all APM users, regardless of their deployment method. Fleet-managed users will no longer be incorrectly directed away from APM-specific settings to general Fleet settings. Fixes: elastic/apm-server#18937 <!-- START COPILOT CODING AGENT SUFFIX --> <details> <summary>Original prompt</summary> > > ---- > > *This section details on the original issue you should resolve* > > <issue_title>[Internal]: APM ES config incorrectly labeled as not applicable to fleet-managed APM</issue_title> > <issue_description>### Description > > Mirrors issue elastic/apm-server#18937 > > In https://www.elastic.co/docs/solutions/observability/apm/apm-server/configure-elasticsearch-output , > > > This documentation only applies to APM Server binary users. Fleet-managed users should see [Configure the Elasticsearch output](https://www.elastic.co/docs/reference/fleet/elasticsearch-output). > > but this is not accurate. The ES configs listed in [APM ES output docs](https://www.elastic.co/docs/solutions/observability/apm/apm-server/configure-elasticsearch-output) are applicable to both standalone and fleet-managed, but the way to configure them through yaml is specific to standalone. Fleet-managed APM needs to configure the [APM ES output configs ](https://www.elastic.co/docs/solutions/observability/apm/apm-server/configure-elasticsearch-output)(not [Fleet ES output configs](https://www.elastic.co/docs/reference/fleet/elasticsearch-output)) via fleet UI > > ### Resources > > https://www.elastic.co/docs/solutions/observability/apm/apm-server/configure-elasticsearch-output > > ### Which documentation set does this change impact? > > Elastic On-Prem and Cloud (all) > > ### Feature differences > > Applies to both on-prem and cloud > > ### What release is this request related to? > > 9.2 > > ### Serverless release > > NA > > ### Collaboration model > > The documentation team > > ### Point of contact. > > **Main contact:** @carsonip > > **Stakeholders:** > </issue_description> > > ## Comments on the Issue (you are @copilot in this section) > > <comments> > </comments> > </details> Fixes elastic#3342 <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/elastic/docs-content/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: carsonip <[email protected]> Co-authored-by: Carson Ip <[email protected]> Co-authored-by: Colleen McGinnis <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The APM Elasticsearch output configuration documentation incorrectly indicated that it only applies to APM Server binary users and not Fleet-managed users. This was misleading because the ES configuration options described are actually applicable to both deployment methods.
Solution
Updated the documentation to correctly reflect that:
Changes Made
observability-binary-yes-fm-no.svgtoobservability-binary-yes-fm-yes.svgto show support for both deployment methodsImpact
This fix ensures users understand that the valuable APM-specific Elasticsearch output configurations documented in this page are available to all APM users, regardless of their deployment method. Fleet-managed users will no longer be incorrectly directed away from APM-specific settings to general Fleet settings.
Fixes: elastic/apm-server#18937
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.